Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create FlagCommentPage #19412

Merged
merged 27 commits into from
May 31, 2023
Merged

Create FlagCommentPage #19412

merged 27 commits into from
May 31, 2023

Conversation

dangrous
Copy link
Contributor

@dangrous dangrous commented May 22, 2023

cc @thienlnam

Details

This is prepping for moderation! You will not see any visual changes to the content right now - not until #19476 is complete - but you can check the props in your console/inspector to make sure that the moderationDecisions property for flagged messages is updated appropriately. You should also get a whisper back, both as the reporter and as the author of the flagged content.

You will also get the 1:1:1 too many commands alert for this on dev - that's because it's flagging the comment and sending two whispers (3x commands total). No way around this at the moment, we'll update the listing on PHP shortly.

Fixed Issues

$ #18508
$ #18503

Tests

  1. Make sure the flag option is visible in the context menus of chats from other users - but not from concierge.
  2. Make sure clicking the flag opens the flag content page.
  3. Make sure that choosing a severity option successfully flags the comment. (Right now you can check the ReportActionItem.message.moderationDecisions to make sure the right decision is added correctly to the right report action. It should be "pending" for spam/inconsiderate, and "pendingHide" for everything else.) [THIS IS WHY WE NEED INTERNAL QA FOR NOW]
  4. Ensure that choosing a severity option successfully sends a whisper to the reporter
  5. Ensure that choosing a severity option successfully sends a whisper identifying the severity level to the reportee.
  • Verify that no errors appear in the JS console

Offline tests

  • Same as Tests; the whispers will of course not be sent but the moderationDecisions should be appropriately updated.

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-05-26 at 15 52 44
Mobile Web - Chrome Screenshot 2023-05-26 at 15 54 51
Mobile Web - Safari Screenshot 2023-05-26 at 15 57 30
Desktop Screenshot 2023-05-26 at 15 55 10
iOS

I cannot run the iOS app currently due to XCode 14.3

Android Screenshot 2023-05-26 at 16 19 53

@dangrous dangrous self-assigned this May 22, 2023
@dangrous dangrous changed the title Create FlagCommentPage [WIP] Create FlagCommentPage May 22, 2023
Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice - looks solid! Just a NAB

src/pages/FlagCommentPage.js Outdated Show resolved Hide resolved
@dangrous dangrous changed the title [WIP] Create FlagCommentPage Create FlagCommentPage May 26, 2023
@dangrous dangrous added the InternalQA This pull request required internal QA label May 26, 2023
@dangrous dangrous marked this pull request as ready for review May 26, 2023 20:20
@dangrous dangrous requested a review from a team as a code owner May 26, 2023 20:20
@melvin-bot melvin-bot bot requested review from eVoloshchak and youssef-lr and removed request for a team May 26, 2023 20:20
@melvin-bot
Copy link

melvin-bot bot commented May 26, 2023

@eVoloshchak @youssef-lr One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@eVoloshchak
Copy link
Contributor

eVoloshchak commented May 30, 2023

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-05-31.at.18.13.17.mov
Mobile Web - Chrome
Mobile Web - Safari
Screen.Recording.2023-05-31.at.18.14.42.mov
Desktop
Screen.Recording.2023-05-31.at.18.16.31.mov
iOS
Screen.Recording.2023-05-31.at.18.15.45.mov
Android

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a couple of issues:

  1. Navigate to a conversation
  2. Right-click on someone elses message
  3. Select "Reply in thread"
  4. Right click on the message in thread
  5. Select "Flag as offensive"
  6. Press on any severity option
  7. Notice nothing is happening and there's error in console
Screen.Recording.2023-05-30.at.14.36.19.mov

On mWeb/iOS/Android or web with isSmallScreenWidth = true

  1. Select "Flag as offensive" on any message
  2. Press on any severity option
  3. Notice that you're navigated back twice (to the list with chats) instead of to the current chat
screen-20230530-143910.mp4

@dangrous
Copy link
Contributor Author

Figured out the double navigation thing; the threads bit is becoming a little trickier. Have asked in Slack here - it's because the route is giving us the new, thread reportID, not the original - so the reportAction isn't found on the new report.

@dangrous
Copy link
Contributor Author

okay i think i fixed the bugs you found @eVoloshchak.

@youssef-lr I am also sometimes getting that issue; doesn't seem like it's related to this, but we can look into it in PHP

@youssef-lr
Copy link
Contributor

@dangrous it's weird though that it's only happening with whispers? as regular messages updates work properly.

@dangrous
Copy link
Contributor Author

annnnnd it does look like attachments will work! I've updated to allow them to be flagged.

youssef-lr
youssef-lr previously approved these changes May 31, 2023
Copy link
Contributor

@youssef-lr youssef-lr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! The bug I found should be fixed in the backend I think.

@dangrous
Copy link
Contributor Author

sorry @youssef-lr I needed to add prettier, can you approve again (i'll still wait for confirmation from @eVoloshchak before merging tho)

@eVoloshchak
Copy link
Contributor

Found one more edge case where the reveal button is hidden for a second

  1. Flag message as Spam
  2. Flag message as Bullying
  3. Go to 'Reply in thread"
  4. Go back to chat
  5. Mark the same message as Spam
Screen.Recording.2023-05-31.at.18.08.25.mov

@dangrous
Copy link
Contributor Author

ooh I think I know why that's happening, it's because onyx.merge goes much deeper than I thought. I thought that this part of the flagComment method was replacing the existing moderationDecisions but it's actually merging them, i.e. adding them. I can get around it in the meantime by just always looking at the latestdecision but not sure if there's a cleaner way.

@dangrous
Copy link
Contributor Author

should be fixed now

@eVoloshchak
Copy link
Contributor

eVoloshchak commented May 31, 2023

Simulator Screen Shot - iPhone 14 - 2023-05-31 at 18 23 04

Also I think this highlight should take up full width with paddings inside it (in case the UI is finalized)

@dangrous
Copy link
Contributor Author

whatttt i fixed that.

@dangrous
Copy link
Contributor Author

fixed. Thanks for being so thorough @eVoloshchak !

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@youssef-lr youssef-lr merged commit 36fe848 into main May 31, 2023
@youssef-lr youssef-lr deleted the dangrous-flagcommentpane branch May 31, 2023 16:28
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.21-1 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

OSBotify commented Jun 1, 2023

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.21-2 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

ReportUtils.canFlagReportAction(reportAction, reportID) &&
!isArchivedRoom &&
!isChronosReport &&
!ReportUtils.isConciergeChatReport(reportID) &&
Copy link
Contributor

@dukenv0307 dukenv0307 Jun 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dangrous Coming from #20197 In this issue, we come up with that ReportUtils.isConciergeChatReport will return true if it is main chat with Concierge (not include thread with Concierge). But the thread chat with Concierge also should not show flag option. Fortuantley, the below condition reportAction.actorEmail !== CONST.EMAIL.CONCIERGE, just handled this case so this condition !ReportUtils.isConciergeChatReport(reportID) is redundant. Should we remove it?
cc @eVoloshchak

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's right! Shouldn't be a need for that. cc @thienlnam in case you see anything wrong with that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sounds good to me, as long as you don't see flag messages in a Concierge chat the problem is solved

));

return (
<ScreenWrapper includeSafeAreaPaddingBottom={false}>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think when we created this component, we didn't add any access controls. Hence this caused a regression.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahhhh nice catch, thank you for calling it out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
InternalQA This pull request required internal QA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants